home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2007 September / PCWSEP07.iso / Software / Linux / Linux Mint 3.0 Light / LinuxMint-3.0-Light.iso / casper / filesystem.squashfs / usr / lib / hplip / base / codes.py < prev    next >
Encoding:
Text File  |  2007-04-04  |  21.6 KB  |  671 lines
  1. # -*- coding: utf-8 -*-
  2. #
  3. # (c) Copyright 2003-2007 Hewlett-Packard Development Company, L.P.
  4. #
  5. # This program is free software; you can redistribute it and/or modify
  6. # it under the terms of the GNU General Public License as published by
  7. # the Free Software Foundation; either version 2 of the License, or
  8. # (at your option) any later version.
  9. #
  10. # This program is distributed in the hope that it will be useful,
  11. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13. # GNU General Public License for more details.
  14. #
  15. # You should have received a copy of the GNU General Public License
  16. # along with this program; if not, write to the Free Software
  17. # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18. #
  19. # Author: Don Welch
  20. #
  21. #
  22. # NOTE: This module is safe for 'from codes import *'
  23. #
  24.  
  25.  
  26. # GUI/Console modes
  27. INTERACTIVE_MODE = 0
  28. GUI_MODE = 1
  29. NON_INTERACTIVE_MODE = 2
  30. BROWSER_MODE = 3
  31.  
  32. # Messaging Error Codes (result-code=)
  33. ERROR_SUCCESS = 0
  34. ERROR_UNKNOWN_ERROR = 1
  35. ERROR_DEVICE_NOT_FOUND = 2
  36. ERROR_INVALID_DEVICE_ID = 3
  37. ERROR_INVALID_DEVICE_URI = 4
  38. ERROR_INVALID_MSG_TYPE = 5
  39. ERROR_INVALID_DATA_ENCODING = 6
  40. ERROR_INVALID_CHAR_ENCODING = 7
  41. ERROR_DATA_LENGTH_EXCEEDS_MAX = 8
  42. ERROR_DATA_LENGTH_MISMATCH = 9
  43. ERROR_DATA_DIGEST_MISMATCH = 10
  44. ERROR_INVALID_JOB_ID = 11
  45. ERROR_DEVICE_IO_ERROR = 12
  46. ERROR_STRING_QUERY_FAILED = 14
  47. ERROR_QUERY_FAILED = 15
  48. ERROR_GUI_NOT_AVAILABLE = 16
  49. ERROR_NO_CUPS_DEVICES_FOUND = 17 # deprecated
  50. ERROR_NO_PROBED_DEVICES_FOUND = 18
  51. ERROR_INVALID_BUS_TYPE = 19 # operation not supported on bus
  52. ERROR_BUS_TYPE_CANNOT_BE_PROBED = 20
  53. ERROR_DEVICE_BUSY = 21
  54. ERROR_NO_DATA_AVAILABLE = 22
  55. ERROR_INVALID_DEVICEID = 23
  56. ERROR_INVALID_CUPS_VERSION = 24
  57. ERROR_CUPS_NOT_RUNNING = 25
  58. ERROR_DEVICE_STATUS_NOT_AVAILABLE = 26
  59. ERROR_DATA_IN_SHORT_READ = 27
  60. ERROR_INVALID_SERVICE_NAME = 28
  61. ERROR_INVALID_USER_ERROR_CODE = 29
  62. ERROR_ERROR_INVALID_CHANNEL_ID = 30
  63. ERROR_CHANNEL_BUSY = 31
  64. ERROR_CHANNEL_CLOSE_FAILED = 32
  65. ERROR_UNSUPPORTED_BUS_TYPE = 33 # bus not supported
  66. ERROR_DEVICE_DOES_NOT_SUPPORT_OPERATION = 34
  67. ERROR_INVALID_GUI_NAME = 35
  68. ERROR_INTERFACE_BUSY = 36
  69. ERROR_DEVICEOPEN_FAILED_ONE_DEVICE_ONLY = 37
  70. ERROR_DEVICEOPEN_FAILED_DEV_NODE_MOVED = 38
  71. ERROR_TEST_EMAIL_FAILED = 39
  72. ERROR_INVALID_HOSTNAME = 45
  73. ERROR_INVALID_PORT_NUMBER = 46
  74. ERROR_NO_CUPS_QUEUE_FOUND_FOR_DEVICE = 47
  75. ERROR_UNSUPPORTED_MODEL = 48
  76. ERROR_FAX_FILE_NOT_FOUND = 49
  77. ERROR_FAX_INCOMPATIBLE_OPTIONS = 50
  78. ERROR_FAX_INVALID_FAX_FILE = 51
  79. ERROR_FAX_MUST_RUN_SENDFAX_FIRST = 52
  80. ERROR_FAX_PROCESSING = 53
  81. ERROR_FAX_READY = 54
  82. # --> add new codes here <--
  83. ERROR_UNABLE_TO_BIND_SOCKET = 95
  84. ERROR_UNABLE_TO_CONTACT_SERVICE = 96
  85. ERROR_DEVICE_NOT_OPEN = 98
  86. ERROR_INTERNAL = 99
  87. # If you add new codes, also add the appropriate description
  88. # to g.py for exception description strings.
  89. # Thank you, The Management
  90.  
  91.  
  92. # Event and status codes
  93. # These are used for the 'status-code' returned by DeviceQuery (STATUS_*)
  94. # and by the event-code used by Event (EVENT_* + STATUS_*)
  95.  
  96. # If you add a new EVENT/STATUS code, please add the appropriate
  97. # entry into the STATUS_TO_ERROR_STATE_MAP
  98.  
  99. STATUS_UNKNOWN = 0
  100.  
  101. EVENT_START_PRINT_JOB = 500 # sent by hp: backend
  102. EVENT_END_PRINT_JOB = 501 # sent by hp: backend
  103. EVENT_START_FAX_PRINT_JOB = 600 # sent by hpfax: backend
  104. EVENT_END_FAX_PRINT_JOB = 601 # sent by hpfax: backend
  105.  
  106. STATUS_PRINTER_BASE = 1000
  107. STATUS_PRINTER_IDLE = 1000
  108. STATUS_PRINTER_BUSY = 1001
  109. STATUS_PRINTER_PRINTING = 1002
  110. STATUS_PRINTER_TURNING_OFF = 1003
  111. STATUS_PRINTER_REPORT_PRINTING = 1004
  112. STATUS_PRINTER_CANCELING = 1005
  113. STATUS_PRINTER_IO_STALL = 1006
  114. STATUS_PRINTER_DRY_WAIT_TIME = 1007
  115. STATUS_PRINTER_PEN_CHANGE = 1008
  116. STATUS_PRINTER_OUT_OF_PAPER = 1009
  117. STATUS_PRINTER_BANNER_EJECT = 1010
  118. STATUS_PRINTER_BANNER_MISMATCH = 1011
  119. STATUS_PRINTER_PHOTO_MISMATCH = 1012
  120. STATUS_PRINTER_DUPLEX_MISMATCH = 1013
  121. STATUS_PRINTER_MEDIA_JAM = 1014
  122. STATUS_PRINTER_CARRIAGE_STALL = 1015
  123. STATUS_PRINTER_PAPER_STALL = 1016
  124. STATUS_PRINTER_PEN_FAILURE = 1017
  125. STATUS_PRINTER_HARD_ERROR = 1018
  126. STATUS_PRINTER_POWER_DOWN = 1019
  127. STATUS_PRINTER_FRONT_PANEL_TEST = 1020
  128. STATUS_PRINTER_CLEAN_OUT_TRAY_MISSING = 1021
  129. STATUS_PRINTER_OUTPUT_BIN_FULL = 1022
  130. STATUS_PRINTER_MEDIA_SIZE_MISMATCH = 1023
  131. STATUS_PRINTER_MANUAL_DUPLEX_BLOCK = 1024
  132. STATUS_PRINTER_SERVCE_STALL = 1025
  133. STATUS_PRINTER_OUT_OF_INK = 1026 # Also used for out of toner
  134. STATUS_PRINTER_LIO_ERROR = 1027
  135. STATUS_PRINTER_PUMP_STALL = 1028
  136. STATUS_PRINTER_TRAY_2_MISSING = 1029
  137. STATUS_PRINTER_DUPLEXER_MISSING = 1030
  138. STATUS_PRINTER_REAR_TRAY_MISSING = 1031
  139. STATUS_PRINTER_PEN_NOT_LATCHED = 1032
  140. STATUS_PRINTER_BATTERY_VERY_LOW = 1033
  141. STATUS_PRINTER_SPITTOON_FULL = 1034
  142. STATUS_PRINTER_OUTPUT_TRAY_CLOSED = 1035
  143. STATUS_PRINTER_MANUAL_FEED_BLOCKED = 1036
  144. STATUS_PRINTER_REAR_FEED_BLOCKED = 1037
  145. STATUS_PRINTER_TRAY_2_OUT_OF_PAPER = 1038
  146. STATUS_PRINTER_UNABLE_TO_LOAD_FROM_LOCKED_TRAY = 1039
  147. STATUS_PRINTER_NON_HP_INK = 1040
  148. STATUS_PRINTER_PEN_CALIBRATION_RESUME = 1041
  149. STATUS_PRINTER_MEDIA_TYPE_MISMATCH = 1042
  150. STATUS_PRINTER_CUSTOM_MEDIA_MISMATCH = 1043
  151. STATUS_PRINTER_PEN_CLEANING = 1044
  152. STATUS_PRINTER_PEN_CHECKING = 1045
  153.  
  154. # "synthetic" codes
  155. # set to AGENT_TYPE + base (base: 1500=ink, 1600=laser )
  156. STATUS_PRINTER_LOW_INK_BASE = 1500
  157. STATUS_PRINTER_LOW_BLACK_INK = 1501
  158. STATUS_PRINTER_LOW_TRI_COLOR_INK = 1502
  159. STATUS_PRINTER_LOW_PHOTO_INK = 1503
  160. STATUS_PRINTER_LOW_CYAN_INK = 1504
  161. STATUS_PRINTER_LOW_MAGENTA_INK = 1505
  162. STATUS_PRINTER_LOW_YELLOW_INK = 1506
  163. STATUS_PRINTER_LOW_PHOTO_CYAN_INK = 1507
  164. STATUS_PRINTER_LOW_PHOTO_MAGENTA_INK = 1508
  165. STATUS_PRINTER_LOW_PHOTO_YELLOW_INK = 1509
  166. STATUS_PRINTER_LOW_PHOTO_GRAY_INK = 1510
  167. STATUS_PRINTER_LOW_PHOTO_BLUE_INK = 1511
  168.  
  169. STATUS_PRINTER_LOW_TONER_BASE = 1600
  170. STATUS_PRINTER_LOW_BLACK_TONER = 1601
  171. STATUS_PRINTER_LOW_CYAN_TONER = 1604
  172. STATUS_PRINTER_LOW_MAGENTA_TONER = 1605
  173. STATUS_PRINTER_LOW_YELLOW_TONER = 1606
  174. # end
  175.  
  176. # "synthetic" laserjet codes
  177. STATUS_PRINTER_WARMING_UP = 1800
  178. STATUS_PRINTER_LOW_PAPER = 1801
  179. STATUS_PRINTER_DOOR_OPEN = 1802
  180. STATUS_PRINTER_OFFLINE = 1803
  181. STATUS_PRINTER_LOW_TONER = 1804
  182. STATUS_PRINTER_NO_TONER = 1805
  183. STATUS_PRINTER_SERVICE_REQUEST = 1806
  184. STATUS_PRINTER_FUSER_ERROR = 1807
  185. #end
  186.  
  187. # other "synthetic" codes
  188. STATUS_DEVICE_UNSUPPORTED = 1900
  189. #end
  190.  
  191. # scan
  192. EVENT_START_SCAN_JOB = 2000
  193. EVENT_END_SCAN_JOB = 2001
  194. EVENT_SCANNER_FAIL = 2002
  195. #end
  196.  
  197. # fax
  198. EVENT_START_FAX_JOB = 3000
  199. EVENT_END_FAX_JOB = 3001
  200. EVENT_FAX_JOB_FAIL = 3002
  201. EVENT_FAX_JOB_CANCELED = 3003
  202. STATUS_FAX_TX_ACTIVE = 3004
  203. STATUS_FAX_RX_ACTIVE = 3005
  204. #end
  205.  
  206. # copy
  207. EVENT_START_COPY_JOB = 4000
  208. EVENT_END_COPY_JOB = 4001
  209. EVENT_COPY_JOB_FAIL = 4002
  210. EVENT_COPY_JOB_CANCELED = 4003
  211. #end
  212.  
  213. # Adding the ERROR_CODE_BASE to the above
  214. # ERROR codes will produce a event/status code
  215. # e.g., ERROR_DATA_IN_SHORT_READ=27 -> 5027 status/event code
  216. ERROR_CODE_BASE = 5000
  217. EVENT_ERROR_SUCCESS = 5000
  218. EVENT_ERROR_UNKNOWN_ERROR = 5001
  219. EVENT_ERROR_DEVICE_NOT_FOUND = 5002
  220. EVENT_ERROR_INVALID_DEVICE_ID = 5003
  221. EVENT_ERROR_INVALID_DEVICE_URI = 5004
  222. EVENT_ERROR_INVALID_MSG_TYPE = 5005
  223. EVENT_ERROR_INVALID_DATA_ENCODING = 5006
  224. EVENT_ERROR_INVALID_CHAR_ENCODING = 5007
  225. EVENT_ERROR_DATA_LENGTH_EXCEEDS_MAX = 5008
  226. EVENT_ERROR_DATA_LENGTH_MISMATCH = 5009
  227. EVENT_ERROR_DATA_DIGEST_MISMATCH = 5010
  228. EVENT_ERROR_INVALID_JOB_ID = 5011
  229. EVENT_ERROR_DEVICE_IO_ERROR = 5012
  230. EVENT_ERROR_STRING_QUERY_FAILED = 5014
  231. EVENT_ERROR_QUERY_FAILED = 5015
  232. EVENT_ERROR_GUI_NOT_AVAILABLE = 5016
  233. EVENT_ERROR_NO_CUPS_DEVICES_FOUND = 5017 # deprecated
  234. EVENT_ERROR_NO_PROBED_DEVICES_FOUND = 5018
  235. EVENT_ERROR_INVALID_BUS_TYPE = 5019 # operation not supported on bus
  236. EVENT_ERROR_BUS_TYPE_CANNOT_BE_PROBED = 5020
  237. EVENT_ERROR_DEVICE_BUSY = 5021
  238. EVENT_ERROR_NO_DATA_AVAILABLE = 5022
  239. EVENT_ERROR_INVALID_DEVICEID = 5023
  240. EVENT_ERROR_INVALID_CUPS_VERSION = 5024
  241. EVENT_ERROR_CUPS_NOT_RUNNING = 5025
  242. EVENT_ERROR_DEVICE_STATUS_NOT_AVAILABLE = 5026
  243. EVENT_ERROR_DATA_IN_SHORT_READ = 5027
  244. EVENT_ERROR_INVALID_SERVICE_NAME = 5028
  245. EVENT_ERROR_INVALID_USER_ERROR_CODE = 5029
  246. EVENT_ERROR_ERROR_INVALID_CHANNEL_ID = 5030
  247. EVENT_ERROR_CHANNEL_BUSY = 5031
  248. EVENT_ERROR_CHANNEL_CLOSE_FAILED = 5032
  249. EVENT_ERROR_UNSUPPORTED_BUS_TYPE = 5033 # bus not supported
  250. EVENT_ERROR_DEVICE_DOES_NOT_SUPPORT_OPERATION = 5034
  251. EVENT_ERROR_INVALID_GUI_NAME = 5035
  252. EVENT_ERROR_INTERFACE_BUSY = 5036
  253. EVENT_ERROR_DEVICEOPEN_FAILED_ONE_DEVICE_ONLY = 5037
  254. EVENT_ERROR_DEVICEOPEN_FAILED_DEV_NODE_MOVED = 5038
  255. EVENT_ERROR_FAX_MUST_RUN_SENDFAX_FIRST = 5052
  256. # end
  257.  
  258. # pcard
  259. EVENT_START_PCARD_JOB = 6000
  260. EVENT_END_PCARD_JOB = 6001
  261. EVENT_PCARD_JOB_FAIL = 6002
  262. EVENT_PCARD_UNABLE_TO_MOUNT = 6003
  263. EVENT_PCARD_FILES_TRANSFERED = 6004
  264. # end
  265.  
  266. EVENT_MAX_USER_EVENT = 7999
  267. # end of user events
  268. # start of internal events
  269.  
  270. # fax (internal events)
  271. EVENT_FAX_MIN = 8000
  272. EVENT_FAX_RENDER_COMPLETE = 8000 # sent by hpssd to hp-sendfax after job rendered
  273. EVENT_FAX_ADDRESS_BOOK_UPDATED = 8002 # Sent by FAB to indicate that the dB has changed
  274. EVENT_FAX_RENDER_DISTANT_EARLY_WARNING = 8003
  275. EVENT_FAX_MAX = 8999
  276. # end
  277.  
  278. EVENT_CUPS_QUEUES_CHANGED = 9000 # sent by hp-setup if queues added (or removed)
  279.  
  280. # end of events
  281.  
  282.  
  283. # Error states
  284. ERROR_STATE_CLEAR = 0        # Show icon w/o overlay
  285. ERROR_STATE_OK = 1           # Icon w/ "OK" overlay
  286. ERROR_STATE_MAX_OK = 99
  287. ERROR_STATE_WARNING = 100      # Icon w/ triangle "!" overlay
  288. ERROR_STATE_ERROR = 101        # Icon w/ circle "X" overlay
  289. ERROR_STATE_LOW_SUPPLIES = 102 # Icon w/ supplies overlay
  290. ERROR_STATE_BUSY = 103         # Icon with busy overlay
  291. ERROR_STATE_LOW_PAPER = 104    # Icon w/ paper low overlay
  292. ERROR_STATE_PRINTING = 105
  293. ERROR_STATE_SCANNING = 106
  294. ERROR_STATE_PHOTOCARD = 107
  295. ERROR_STATE_FAXING = 108
  296. ERROR_STATE_COPYING = 109
  297. #end
  298.  
  299.  
  300. # Map of status/event codes to UI states
  301. STATUS_TO_ERROR_STATE_MAP = {
  302.     STATUS_UNKNOWN : ERROR_STATE_CLEAR,
  303.     EVENT_START_PRINT_JOB : ERROR_STATE_PRINTING,
  304.     EVENT_END_PRINT_JOB   : ERROR_STATE_OK,
  305.     EVENT_START_FAX_PRINT_JOB : ERROR_STATE_CLEAR,
  306.     EVENT_END_FAX_PRINT_JOB : ERROR_STATE_OK,
  307.     STATUS_PRINTER_IDLE : ERROR_STATE_CLEAR,
  308.     STATUS_PRINTER_BUSY : ERROR_STATE_BUSY,
  309.     STATUS_PRINTER_PRINTING : ERROR_STATE_PRINTING,
  310.     STATUS_PRINTER_TURNING_OFF : ERROR_STATE_BUSY,
  311.     STATUS_PRINTER_REPORT_PRINTING : ERROR_STATE_PRINTING,
  312.     STATUS_PRINTER_CANCELING : ERROR_STATE_BUSY,
  313.     STATUS_PRINTER_IO_STALL : ERROR_STATE_ERROR,
  314.     STATUS_PRINTER_DRY_WAIT_TIME : ERROR_STATE_PRINTING,
  315.     STATUS_PRINTER_PEN_CHANGE : ERROR_STATE_WARNING,
  316.     STATUS_PRINTER_OUT_OF_PAPER : ERROR_STATE_ERROR,
  317.     STATUS_PRINTER_BANNER_EJECT : ERROR_STATE_ERROR,
  318.     STATUS_PRINTER_BANNER_MISMATCH : ERROR_STATE_WARNING,
  319.     STATUS_PRINTER_PHOTO_MISMATCH : ERROR_STATE_WARNING,
  320.     STATUS_PRINTER_DUPLEX_MISMATCH : ERROR_STATE_WARNING,
  321.     STATUS_PRINTER_MEDIA_JAM : ERROR_STATE_ERROR,
  322.     STATUS_PRINTER_CARRIAGE_STALL : ERROR_STATE_ERROR,
  323.     STATUS_PRINTER_PAPER_STALL : ERROR_STATE_ERROR,
  324.     STATUS_PRINTER_PEN_FAILURE : ERROR_STATE_ERROR,
  325.     STATUS_PRINTER_HARD_ERROR : ERROR_STATE_ERROR,
  326.     STATUS_PRINTER_POWER_DOWN : ERROR_STATE_ERROR,
  327.     STATUS_PRINTER_FRONT_PANEL_TEST : ERROR_STATE_ERROR,
  328.     STATUS_PRINTER_CLEAN_OUT_TRAY_MISSING : ERROR_STATE_ERROR,
  329.     STATUS_PRINTER_OUTPUT_BIN_FULL : ERROR_STATE_ERROR,
  330.     STATUS_PRINTER_MEDIA_SIZE_MISMATCH : ERROR_STATE_WARNING,
  331.     STATUS_PRINTER_MANUAL_DUPLEX_BLOCK : ERROR_STATE_ERROR,
  332.     STATUS_PRINTER_SERVCE_STALL : ERROR_STATE_ERROR,
  333.     STATUS_PRINTER_OUT_OF_INK : ERROR_STATE_ERROR,
  334.     STATUS_PRINTER_LIO_ERROR : ERROR_STATE_ERROR,
  335.     STATUS_PRINTER_PUMP_STALL : ERROR_STATE_ERROR,
  336.     STATUS_PRINTER_TRAY_2_MISSING : ERROR_STATE_ERROR,
  337.     STATUS_PRINTER_DUPLEXER_MISSING : ERROR_STATE_ERROR,
  338.     STATUS_PRINTER_REAR_TRAY_MISSING : ERROR_STATE_ERROR,
  339.     STATUS_PRINTER_PEN_NOT_LATCHED : ERROR_STATE_ERROR,
  340.     STATUS_PRINTER_BATTERY_VERY_LOW : ERROR_STATE_WARNING,
  341.     STATUS_PRINTER_SPITTOON_FULL : ERROR_STATE_ERROR,
  342.     STATUS_PRINTER_OUTPUT_TRAY_CLOSED : ERROR_STATE_ERROR,
  343.     STATUS_PRINTER_MANUAL_FEED_BLOCKED : ERROR_STATE_ERROR,
  344.     STATUS_PRINTER_REAR_FEED_BLOCKED : ERROR_STATE_ERROR,
  345.     STATUS_PRINTER_TRAY_2_OUT_OF_PAPER : ERROR_STATE_LOW_PAPER,
  346.     STATUS_PRINTER_UNABLE_TO_LOAD_FROM_LOCKED_TRAY : ERROR_STATE_ERROR,
  347.     STATUS_PRINTER_NON_HP_INK : ERROR_STATE_WARNING,
  348.     STATUS_PRINTER_PEN_CALIBRATION_RESUME : ERROR_STATE_WARNING,
  349.     STATUS_PRINTER_MEDIA_TYPE_MISMATCH : ERROR_STATE_WARNING,
  350.     STATUS_PRINTER_CUSTOM_MEDIA_MISMATCH : ERROR_STATE_WARNING,
  351.     STATUS_PRINTER_PEN_CLEANING : ERROR_STATE_WARNING,
  352.     STATUS_PRINTER_PEN_CLEANING : ERROR_STATE_WARNING,
  353.     STATUS_PRINTER_WARMING_UP : ERROR_STATE_BUSY,
  354.     STATUS_PRINTER_LOW_PAPER : ERROR_STATE_LOW_PAPER,
  355.     STATUS_PRINTER_DOOR_OPEN : ERROR_STATE_ERROR,
  356.     STATUS_PRINTER_OFFLINE : ERROR_STATE_ERROR,
  357.     STATUS_PRINTER_LOW_TONER : ERROR_STATE_LOW_SUPPLIES,
  358.     STATUS_PRINTER_NO_TONER : ERROR_STATE_LOW_SUPPLIES,
  359.     STATUS_PRINTER_SERVICE_REQUEST : ERROR_STATE_ERROR,
  360.     STATUS_PRINTER_FUSER_ERROR : ERROR_STATE_ERROR,
  361.     STATUS_DEVICE_UNSUPPORTED : ERROR_STATE_ERROR,
  362.     # The following block are EVENTs because they are only
  363.     # recieved as events from hpiod, hp backend, etc.
  364.     # i.e., a device does not produce status codes in this range
  365.     EVENT_ERROR_SUCCESS : ERROR_STATE_CLEAR,
  366.     EVENT_ERROR_UNKNOWN_ERROR : ERROR_STATE_ERROR,
  367.     EVENT_ERROR_DEVICE_NOT_FOUND : ERROR_STATE_ERROR,
  368.     EVENT_ERROR_INVALID_DEVICE_ID : ERROR_STATE_ERROR,
  369.     EVENT_ERROR_INVALID_DEVICE_URI : ERROR_STATE_ERROR,
  370.     EVENT_ERROR_INVALID_MSG_TYPE : ERROR_STATE_ERROR,
  371.     EVENT_ERROR_INVALID_DATA_ENCODING : ERROR_STATE_ERROR,
  372.     EVENT_ERROR_INVALID_CHAR_ENCODING : ERROR_STATE_ERROR,
  373.     EVENT_ERROR_DATA_LENGTH_EXCEEDS_MAX : ERROR_STATE_WARNING,
  374.     EVENT_ERROR_DATA_LENGTH_MISMATCH : ERROR_STATE_ERROR,
  375.     EVENT_ERROR_DATA_DIGEST_MISMATCH : ERROR_STATE_ERROR,
  376.     EVENT_ERROR_INVALID_JOB_ID : ERROR_STATE_ERROR,
  377.     EVENT_ERROR_DEVICE_IO_ERROR : ERROR_STATE_ERROR,
  378.     EVENT_ERROR_STRING_QUERY_FAILED : ERROR_STATE_ERROR,
  379.     EVENT_ERROR_QUERY_FAILED : ERROR_STATE_ERROR,
  380.     EVENT_ERROR_GUI_NOT_AVAILABLE : ERROR_STATE_WARNING,
  381.     EVENT_ERROR_NO_CUPS_DEVICES_FOUND : ERROR_STATE_WARNING,
  382.     EVENT_ERROR_NO_PROBED_DEVICES_FOUND : ERROR_STATE_WARNING,
  383.     EVENT_ERROR_INVALID_BUS_TYPE : ERROR_STATE_ERROR,
  384.     EVENT_ERROR_BUS_TYPE_CANNOT_BE_PROBED : ERROR_STATE_ERROR,
  385.     EVENT_ERROR_DEVICE_BUSY : ERROR_STATE_BUSY,
  386.     EVENT_ERROR_NO_DATA_AVAILABLE : ERROR_STATE_ERROR,
  387.     EVENT_ERROR_INVALID_DEVICEID : ERROR_STATE_ERROR,
  388.     EVENT_ERROR_INVALID_CUPS_VERSION : ERROR_STATE_ERROR,
  389.     EVENT_ERROR_CUPS_NOT_RUNNING : ERROR_STATE_ERROR,
  390.     EVENT_ERROR_DEVICE_STATUS_NOT_AVAILABLE : ERROR_STATE_ERROR,
  391.     EVENT_ERROR_DATA_IN_SHORT_READ : ERROR_STATE_ERROR,
  392.     EVENT_ERROR_INVALID_SERVICE_NAME : ERROR_STATE_ERROR,
  393.     EVENT_ERROR_INVALID_USER_ERROR_CODE : ERROR_STATE_ERROR,
  394.     EVENT_ERROR_ERROR_INVALID_CHANNEL_ID : ERROR_STATE_ERROR,
  395.     EVENT_ERROR_CHANNEL_BUSY : ERROR_STATE_BUSY,
  396.     EVENT_ERROR_CHANNEL_CLOSE_FAILED : ERROR_STATE_ERROR,
  397.     EVENT_ERROR_UNSUPPORTED_BUS_TYPE : ERROR_STATE_ERROR,
  398.     EVENT_ERROR_DEVICE_DOES_NOT_SUPPORT_OPERATION : ERROR_STATE_ERROR,
  399.     EVENT_ERROR_INVALID_GUI_NAME : ERROR_STATE_ERROR,
  400.     EVENT_ERROR_INTERFACE_BUSY : ERROR_STATE_BUSY,
  401.     EVENT_ERROR_DEVICEOPEN_FAILED_ONE_DEVICE_ONLY : ERROR_STATE_ERROR,
  402.     EVENT_ERROR_DEVICEOPEN_FAILED_DEV_NODE_MOVED : ERROR_STATE_ERROR,
  403.     # Scan
  404.     EVENT_START_SCAN_JOB : ERROR_STATE_SCANNING,
  405.     EVENT_END_SCAN_JOB : ERROR_STATE_OK,
  406.     EVENT_SCANNER_FAIL : ERROR_STATE_ERROR,
  407.     # Fax
  408.     EVENT_START_FAX_JOB : ERROR_STATE_FAXING,
  409.     EVENT_END_FAX_JOB : ERROR_STATE_OK,
  410.     EVENT_FAX_JOB_FAIL : ERROR_STATE_ERROR,
  411.     EVENT_FAX_JOB_CANCELED : ERROR_STATE_ERROR,
  412.     STATUS_FAX_TX_ACTIVE : ERROR_STATE_FAXING,
  413.     STATUS_FAX_RX_ACTIVE : ERROR_STATE_FAXING,
  414.     # Copy
  415.     EVENT_START_COPY_JOB : ERROR_STATE_COPYING,
  416.     EVENT_END_COPY_JOB : ERROR_STATE_OK,
  417.     EVENT_COPY_JOB_FAIL : ERROR_STATE_ERROR,
  418.     EVENT_COPY_JOB_CANCELED : ERROR_STATE_ERROR,
  419.     # PCard
  420.     EVENT_START_PCARD_JOB : ERROR_STATE_PHOTOCARD,
  421.     EVENT_END_PCARD_JOB : ERROR_STATE_CLEAR,
  422.     EVENT_PCARD_JOB_FAIL : ERROR_STATE_ERROR,
  423.     EVENT_PCARD_UNABLE_TO_MOUNT : ERROR_STATE_ERROR,
  424.     EVENT_PCARD_FILES_TRANSFERED : ERROR_STATE_OK,
  425. }
  426.  
  427.  
  428. # Device states
  429. DEVICE_STATE_NOT_FOUND = -1
  430. DEVICE_STATE_FOUND = 0
  431. DEVICE_STATE_JUST_FOUND = 1
  432.  
  433.  
  434. # I/O states
  435. IO_STATE_HP_OPEN = 0
  436. IO_STATE_HP_READY = 1
  437. IO_STATE_HP_NOT_AVAIL = 2
  438. IO_STATE_NON_HP = 3
  439.  
  440. #
  441. # Defines for model query types and status query
  442. #
  443.  
  444. # agent info
  445.  
  446. # 'kind'
  447. AGENT_KIND_NONE = 0
  448. AGENT_KIND_HEAD = 1 # InkJet head (no ink)
  449. AGENT_KIND_SUPPLY = 2 # InkJet supply (ink tank)
  450. AGENT_KIND_HEAD_AND_SUPPLY = 3 # InkJet (cartridge)
  451. AGENT_KIND_TONER_CARTRIDGE = 4 # LaserJet
  452. AGENT_KIND_MAINT_KIT = 5 # LaserJet "Maintenance kit (fuser)"
  453. AGENT_KIND_ADF_KIT = 6 # LaserJet "Document feeder kit"
  454. AGENT_KIND_DRUM_KIT = 7 # LaserJet
  455. AGENT_KIND_TRANSFER_KIT = 8 # LaserJet
  456. AGENT_KIND_INT_BATTERY = 9 # Mobile deskjet (DJ450, etc)
  457. AGENT_KIND_UNKNOWN = 0x3e # (62)
  458.  
  459. # 'type'
  460. AGENT_TYPE_NONE = 0
  461. AGENT_TYPE_BLACK = 1
  462. AGENT_TYPE_CMY = 2 # Tricolor
  463. AGENT_TYPE_KCM = 3 # Photo
  464. AGENT_TYPE_CYAN = 4
  465. AGENT_TYPE_MAGENTA = 5
  466. AGENT_TYPE_YELLOW = 6
  467. AGENT_TYPE_CYAN_LOW = 7
  468. AGENT_TYPE_MAGENTA_LOW = 8
  469. AGENT_TYPE_YELLOW_LOW = 9
  470. AGENT_TYPE_GGK = 10 # 2 shades of grey and black
  471. AGENT_TYPE_BLUE = 11
  472. AGENT_TYPE_KCMY_CM = 12 # K/C/M/Y/LM/LC (02 pen set head)
  473. AGENT_TYPE_LC_LM = 13 # light cyan and light magenta
  474. #AGENT_TYPE_Y_M = 14 # yellow and magenta (B9180)
  475. #AGENT_TYPE_C_K = 15 # cyan and black (B9180)
  476. AGENT_TYPE_K_Y = 14 # black and yellow (for LJ Pro)
  477. AGENT_TYPE_C_M = 15 # cyan and magenta (for LJ Pro)
  478. AGENT_TYPE_LG_PK = 16 # light grey and photo black
  479. AGENT_TYPE_LG = 17 # light grey
  480. AGENT_TYPE_G = 18 # medium grey
  481. AGENT_TYPE_PG = 19 # photo grey
  482. AGENT_TYPE_WHITE = 0x20 # For ISO 10180 compatibility
  483. AGENT_TYPE_RED = 0x21 # For ISO 10180 compatibility
  484. AGENT_TYPE_UNSPECIFIED = 0x3e # (62) Used for kind = 5, 6, 7, 8, or 9
  485. AGENT_TYPE_ERROR = 0x3f # (63)
  486.  
  487. # 'health'
  488. AGENT_HEALTH_OK = 0
  489. AGENT_HEALTH_MISINSTALLED = 1 # supply/cart
  490. AGENT_HEALTH_FAIR_MODERATE = 1 # head
  491. AGENT_HEALTH_INCORRECT = 2
  492. AGENT_HEALTH_FAILED = 3
  493. AGENT_HEALTH_OVERTEMP = 4 # Battery
  494. AGENT_HEALTH_CHARGING = 5 # Battery
  495. AGENT_HEALTH_DISCHARGING = 6 # Battery
  496. AGENT_HEALTH_UNKNOWN = 0xff
  497.  
  498. # 'level'
  499. AGENT_LEVEL_TRIGGER_SUFFICIENT_0 = 0
  500. AGENT_LEVEL_TRIGGER_SUFFICIENT_1 = 1
  501. AGENT_LEVEL_TRIGGER_SUFFICIENT_2 = 2
  502. AGENT_LEVEL_TRIGGER_SUFFICIENT_3 = 3
  503. AGENT_LEVEL_TRIGGER_SUFFICIENT_4 = 4
  504. AGENT_LEVEL_TRIGGER_MAY_BE_LOW = 5
  505. AGENT_LEVEL_TRIGGER_PROBABLY_OUT = 6
  506. AGENT_LEVEL_TRIGGER_ALMOST_DEFINITELY_OUT = 7
  507.  
  508. # "Computed" configurations (2-pen products)
  509. AGENT_CONFIG_NONE = 0
  510. AGENT_CONFIG_BLACK_ONLY = 1
  511. AGENT_CONFIG_PHOTO_ONLY = 2
  512. AGENT_CONFIG_COLOR_ONLY = 3
  513. AGENT_CONFIG_GREY_ONLY = 4
  514. AGENT_CONFIG_COLOR_AND_BLACK = 5
  515. AGENT_CONFIG_COLOR_AND_PHOTO = 6
  516. AGENT_CONFIG_COLOR_AND_GREY = 7
  517. AGENT_CONFIG_INVALID = 99
  518.  
  519. # align-types
  520. ALIGN_TYPE_NONE = 0
  521. ALIGN_TYPE_AUTO = 1
  522. ALIGN_TYPE_8XX = 2
  523. ALIGN_TYPE_9XX = 3
  524. ALIGN_TYPE_LIDIL_0_3_8 = 4
  525. ALIGN_TYPE_LIDIL_0_4_3 = 5
  526. ALIGN_TYPE_LIDIL_AIO = 6
  527. ALIGN_TYPE_LIDIL_VIP = 7
  528. ALIGN_TYPE_DESKJET_450 = 8
  529. ALIGN_TYPE_9XX_NO_EDGE_ALIGN = 9
  530. ALIGN_TYPE_LBOW = 10
  531. ALIGN_TYPE_LIDIL_0_5_4 = 11
  532. ALIGN_TYPE_OJ_PRO = 12 # OJ Pro L7xxx
  533.  
  534. # clean-types
  535. CLEAN_TYPE_NONE = 0
  536. CLEAN_TYPE_PCL = 1
  537. CLEAN_TYPE_LIDIL = 2
  538. CLEAN_TYPE_PCL_WITH_PRINTOUT = 3
  539.  
  540. # color-cal-types
  541. COLOR_CAL_TYPE_NONE = 0
  542. COLOR_CAL_TYPE_DESKJET_450 = 1
  543. COLOR_CAL_TYPE_MALIBU_CRICK = 2
  544. COLOR_CAL_TYPE_STRINGRAY_LONGBOW_TORNADO = 3
  545. COLOR_CAL_TYPE_CONNERY = 4
  546. COLOR_CAL_TYPE_COUSTEAU = 5
  547. COLOR_CAL_TYPE_CARRIER = 6
  548.  
  549. # status-types
  550. STATUS_TYPE_NONE = 0
  551. STATUS_TYPE_VSTATUS = 1
  552. STATUS_TYPE_S = 2
  553. STATUS_TYPE_LJ = 3
  554. #STATUS_TYPE_S_W_BATTERY = 4 # DEPRECATED
  555. #STATUS_TYPE_S_SNMP = 5 # DEPRECATED
  556. STATUS_TYPE_LJ_XML = 6
  557. #STATUS_TYPE_S_LIDIL = 7 # DEPRECATED
  558.  
  559. # status-battery-check-types
  560. STATUS_BATTERY_CHECK_NONE = 0
  561. STATUS_BATTERY_CHECK_STD = 1 # Deskjet 450/460
  562.  
  563. # status-dynamic-counters-type
  564. STATUS_DYNAMIC_COUNTERS_NONE = 0
  565. STATUS_DYNAMIC_COUNTERS_PCL = 1
  566. STATUS_DYNAMIC_COUNTERS_PML_SNMP = 2
  567. STATUS_DYNAMIC_COUNTERS_LIDIL_0_5_4 = 3 # Deskjet D4100
  568.  
  569. # tech-types
  570. TECH_TYPE_NONE = 0
  571. TECH_TYPE_MONO_INK = 1
  572. TECH_TYPE_COLOR_INK = 2
  573. TECH_TYPE_MONO_LASER = 3
  574. TECH_TYPE_COLOR_LASER = 4
  575. TECH_TYPE_COLOR_EDGELINE = 5
  576.  
  577. # support-type
  578. SUPPORT_TYPE_NONE = 0
  579. SUPPORT_TYPE_HPIJS = 1
  580. SUPPORT_TYPE_HPLIP = 2
  581.  
  582. # fax-types
  583. FAX_TYPE_NONE = 0
  584. FAX_TYPE_BLACK_SEND_EARLY_OPEN = 1 # newer models
  585. FAX_TYPE_BLACK_SEND_LATE_OPEN = 2 # older models
  586. FAX_TYPE_BLACK_AND_COLOR_SEND = 3 # future
  587.  
  588. # pcard-types
  589. PCARD_TYPE_NONE = 0
  590. PCARD_TYPE_MLC = 1
  591. PCARD_TYPE_USB_MASS_STORAGE = 2
  592.  
  593. # scan-types
  594. SCAN_TYPE_NONE = 0
  595. SCAN_TYPE_SCL = 1
  596. SCAN_TYPE_PML = 2
  597. SCAN_TYPE_SOAP = 3
  598.  
  599. # scan-styles
  600. SCAN_STYLE_NONE = 0
  601. SCAN_STYLE_FLATBED = 1
  602. SCAN_STYLE_SCROLLFED = 2
  603.  
  604. # copy-types
  605. COPY_TYPE_NONE = 0
  606. COPY_TYPE_DEVICE = 1 # LaserJet MFP PML
  607. COPY_TYPE_SCAN_TO_PRINT = 2
  608. COPY_TYPE_AIO_DEVICE = 3 # Inkjet AiO PML
  609.  
  610. # 'top_door' (lid)
  611. TOP_DOOR_NOT_PRESENT = 0
  612. TOP_DOOR_CLOSED = 1
  613. TOP_DOOR_OPEN = 2
  614.  
  615. # 'supply_door'
  616. SUPPLY_DOOR_NOT_PRESENT = 0
  617. SUPPLY_DOOR_CLOSED = 1
  618. SUPPLY_DOOR_OPEN = 2
  619.  
  620. # 'media_path'
  621. MEDIA_PATH_NOT_PRESENT = 0 # S:00 means banner not present
  622. MEDIA_PATH_CUT_SHEET = 1 # S:01 means banner present/engaged
  623. MEDIA_PATH_BANNER = 2
  624. MEDIA_PATH_PHOTO = 3
  625.  
  626. # 'photo_tray'(S:03 photo/hagaki)
  627. PHOTO_TRAY_NOT_PRESENT = 0
  628. PHOTO_TRAY_NOT_ENGAGED = 1
  629. PHOTO_TRAY_ENGAGED = 2
  630.  
  631. # 'duplexer' (S:02 cleanout)
  632. DUPLEXER_NOT_PRESENT = 0
  633. DUPLEXER_DOOR_CLOSED = 1
  634. DUPLEXER_DOOR_OPEN = 2
  635.  
  636. # 'in_tray1' & 'in_tray2'
  637. IN_TRAY_NOT_PRESENT = 0
  638. IN_TRAY_PRESENT = 1 # for !S:02, test for > IN_TRAY_NOT_PRESENT
  639. IN_TRAY_DEFAULT = 2 # S:02 only
  640. IN_TRAY_LOCKED = 3 # S:02 only
  641.  
  642. # 'io-support'
  643. IO_SUPPORT_PARALLEL = 0x1
  644. IO_SUPPORT_USB = 0x2
  645. IO_SUPPORT_NETWORK = 0x4
  646. IO_SUPPORT_WIRELESS = 0x8
  647. IO_SUPPORT_BLUETOOTH = 0x10
  648.  
  649. # Model categories
  650. MODEL_TYPE_UNSUPPORTED = -1
  651. MODEL_TYPE_COLOR_INKJET = 0
  652. MODEL_TYPE_PHOTOSMART = 1
  653. MODEL_TYPE_COLOR_LASER = 2
  654. MODEL_TYPE_COLOR_LASER_AIO = 3
  655. MODEL_TYPE_COLOR_INKJET_AIO = 4
  656. MODEL_TYPE_MONO_LASER = 5
  657. MODEL_TYPE_MONO_LASER_AIO = 6
  658. MODEL_TYPE_EDGELINE = 7
  659.  
  660. # 'io-mode'
  661. IO_MODE_UNI = 0
  662. IO_MODE_RAW = 1
  663. IO_MODE_MLC = 2
  664. IO_MODE_DOT4 = 3
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671.